Skip to content

docs: add CMake and vcpkg build pages#132

Merged
MisterVVP merged 2 commits into
mainfrom
dev-add-documentation-for-vcpkg-page
Jul 5, 2026
Merged

docs: add CMake and vcpkg build pages#132
MisterVVP merged 2 commits into
mainfrom
dev-add-documentation-for-vcpkg-page

Conversation

@MisterVVP

@MisterVVP MisterVVP commented Jul 4, 2026

Copy link
Copy Markdown
Owner

Motivation

  • The repository's mdBook lacked concrete guidance for building the SDK with CMake and for using vcpkg, leaving build/cmake.html and its vcpkg subpage empty.
  • Provide clear, reproducible instructions for developers and CI consumers covering source builds, installable package usage, FetchContent integration, and vcpkg manifest/overlay flows.
  • Align documentation with the repository's existing CI and packaging conventions (triplets, overlay port, postgres feature, binary caching, and troubleshooting).

Description

  • Added book/src/build/cmake.md with requirements, configure/build/test commands, CMake options, generated protobuf header location, install-as-package examples, FetchContent usage, exported targets, curated examples, and platform notes.
  • Added book/src/build/vcpkg.md with vcpkg prerequisites, manifest-mode build instructions, Visual Studio/multi-config guidance, triplet usage, overlay-port consumption, the postgres-store feature, classic-mode smoke install steps, binary caching tips, and troubleshooting hints.
  • Validated the mdBook build to ensure pages render and are discoverable from the book navigation.

@MisterVVP MisterVVP added the codex Open AI agent contribution label Jul 4, 2026 — with ChatGPT Codex Connector
@MisterVVP MisterVVP merged commit bb76f24 into main Jul 5, 2026
5 checks passed
@MisterVVP MisterVVP deleted the dev-add-documentation-for-vcpkg-page branch July 5, 2026 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

codex Open AI agent contribution

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant